Skip to content

chore(release): render docs in the changelog and widen the commitlint scopes - #124

Merged
MarTrepodi merged 3 commits into
developfrom
chore/changelog-docs-section
Aug 3, 2026
Merged

chore(release): render docs in the changelog and widen the commitlint scopes#124
MarTrepodi merged 3 commits into
developfrom
chore/changelog-docs-section

Conversation

@MarTrepodi

Copy link
Copy Markdown
Collaborator

Stacked on #123 — this PR targets fix/integration-items-param, not develop.
It cannot merge until #123 lands. GitHub retargets this PR to develop automatically once #123 is merged. The diff shown here is only this branch's three commits.

Changelog generation currently drops every docs commit, and duplicates entries for single-commit PRs.

Changes

Render the docs section[tool.git-changelog] set no sections key, so only the angular convention's defaults (feat, fix, revert, refactor, perf) reached the changelog. Supplying sections replaces the default list rather than extending it, so the defaults are spelled out alongside docs.

Keep the release bookkeeping commit out of the rendered sectionsprepare-release.yml committed the regenerated changelog as docs(changelog): update for ${tag}. With docs now rendered, every release would list the previous release's own changelog regeneration. Changed to chore(changelog), which is not in the render list.

Cover the scopes actually in use in the commitlint enum — surveyed the scopes appearing in real commits against the allowed list. Nine were missing and all map to real code areas: client, auth, statcalc, exceptions, cache, defaults, typing, parity, and changelog. The rule is warn-only, so nothing was failing, but the warnings were noise.

Deliberately omitted: contributing and dependabot, used once each and already covered by docs and deps.

Note

This does not fix the duplicate-entry problem itself. That was caused by the repository's merge_commit_title setting being PR_TITLE, which gave every merge commit a subject identical to the underlying commit on single-commit PRs. That setting has been changed to MERGE_MESSAGE and needs no code change. Existing history is unaffected, so the v2.3.0 changelog will still show the #117 cache feature twice unless that line is removed by hand on the release PR.

🤖 Generated with Claude Code

@github-actions github-actions Bot added ci Changes related to continuous integration processes dependencies Updates to package dependency libraries labels Aug 3, 2026
@MarTrepodi
MarTrepodi force-pushed the chore/changelog-docs-section branch from 0186e55 to a0fb51f Compare August 3, 2026 02:19
@MarTrepodi
MarTrepodi force-pushed the chore/changelog-docs-section branch from a0fb51f to 6cc83d9 Compare August 3, 2026 02:31
Base automatically changed from fix/integration-items-param to develop August 3, 2026 09:58
@MarTrepodi
MarTrepodi merged commit c501463 into develop Aug 3, 2026
1 check passed
@MarTrepodi
MarTrepodi deleted the chore/changelog-docs-section branch August 3, 2026 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Changes related to continuous integration processes dependencies Updates to package dependency libraries

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant